Confirmation of Funds APIs 4.0

4.0.x
(0 reviews)

Confirmation of Funds Examples

This section provides examples of API invocation to confirm availability of funds information.

1. POST – Funds Confirmation Consent

This API can be used by CBPII to post the consent request for the pre-selected customer account.

Post request: Funds Confirmation Consent

POST /funds-confirmation-consents HTTP/1.1

Authorization: Bearer 1t1satruthun1v3rs4lly
Accept: application/json; charset=utf-8
x-fapi-auth-date: Mon, 13 Nov 2017 19:49:37 GMT
x-fapi-customer-ip-address: 92.11.92.11
x-fapi-interaction-id: 79b127c4-65eb-4f8b-b128-059861bc790c
{
  "Data": {
    "DebtorAccount": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "90480070872491"
    },
    "ExpirationDateTime": "2026-12-09T00:00:00+00:00"
  }
}

Post response: Funds Confirmation Consent

HTTP/1.1 201 Created

Content-Type: application/json
x-fapi-interaction-id: 79b127c4-65eb-4f8b-b128-059861bc790c

{
    "Data": {
        "ConsentId": "4cd089ec-c81c-4476-ab37-fb2aa44b8344",
        "CreationDateTime": "2026-07-31T12:31:29+00:00",
        "Status": "AWAU",
        "StatusUpdateDateTime": "2026-07-31T12:31:29+00:00",
        "ExpirationDateTime": "2026-12-09T00:00:00+00:00",
        "DebtorAccount": {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "90480070872491"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/cbpii/funds-confirmation-consents/4cd089ec-c81c-4476-ab37-fb2aa44b8344"
    },
    "Meta": {}
}

2. GET – Funds Confirmation Consent

This API allows a CBPII to get the status of the consent request for the pre-selected customer account.

GET request: Funds Confirmation Consent

GET /funds-confirmation-consents/4cd089ec-c81c-4476-ab37-fb2aa44b8344 HTTP/1.1

Authorization: Bearer Jhingapulaav
x-fapi-interaction-id: b72028f1-7092-4794-aa58-372aafd1f921
Accept: application/json

GET response: Funds Confirmation Consent

HTTP/1.1 200 OK

Content-Type: application/json
{
    "Data": {
        "ConsentId": "4cd089ec-c81c-4476-ab37-fb2aa44b8344",
        "CreationDateTime": "2026-07-31T12:31:29+00:00",
        "Status": "AWAU",
        "StatusUpdateDateTime": "2026-07-31T12:31:29+00:00",
        "ExpirationDateTime": "2026-12-09T00:00:00+00:00",
        "DebtorAccount": {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "90480070872491"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/cbpii/funds-confirmation-consents/4cd089ec-c81c-4476-ab37-fb2aa44b8344"
    },
    "Meta": {}
}

3. Funds Confirmation

This API allows a CBPII to confirm availability of funds on a customer consented account.

Post request: Funds Confirmation

POST /funds-confirmations HTTP/1.1

Content-Type: application/json
Authorization: Bearer 1t1satruthun1v3rs4lly
Accept: application/json; charset=utf-8
x-fapi-interaction-id: cd1b4b4f-22a8-4984-be8d-6713c3e672c1

{
  "Data": {
    "Reference":"sdf344dgsedfg32",
    "ConsentId": "4cd089ec-c81c-4476-ab37-fb2aa44b8344",
    "InstructedAmount": {
       "Amount": "10.50",
       "Currency": "GBP"
    }
  }
}

Post response: Funds Confirmation

HTTP/1.1 201 Created

Content-Type: application/json
x-fapi-interaction-id: cd1b4b4f-22a8-4984-be8d-6713c3e672c1

{
    "Data": {
        "FundsConfirmationId": "62bab534-5207-42a4-b052-ac37b17f6bbb",
        "ConsentId": "4cd089ec-c81c-4476-ab37-fb2aa44b8344",
        "CreationDateTime": "2026-07-31T12:35:42+00:00",
        "FundsAvailable": true,
        "Reference": "sdf344dgsedfg32",
        "InstructedAmount": {
            "Amount": "10.50",
            "Currency": "GBP"
        }
    },
    "Links": {
        "Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/cbpii/funds-confirmations/62bab534-5207-42a4-b052-ac37b17f6bbb"
    },
    "Meta": {}
}

4. DELETE - Funds Confirmation Consent

This API can be used to revoke the consent for confirmation of funds.

DELETE request: Funds Confirmation Consent

DELETE /funds-confirmation-consents/4cd089ec-c81c-4476-ab37-fb2aa44b8344 HTTP/1.1

Authorization: Bearer Jhingakulhav
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: b72028f1-7092-4794-aa58-372aafd1f921

DELETE response: Funds Confirmation Consent

HTTP/1.1 204 No Content
x-fapi-interaction-id: b72028f1-7092-4794-aa58-372aafd1f921

Versioning

This API specification conforms to the Open Banking UK Confirmation of Funds API Specification – v4.0

Reviews